home *** CD-ROM | disk | FTP | other *** search
/ MacFormat 1995 April / macformat-023.iso / Shareware City / Updaters / PopupFuncs 2.5 Update / PopupFuncs Notes < prev   
Encoding:
Text File  |  1994-12-11  |  8.9 KB  |  227 lines  |  [TEXT/R*ch]
  1. PopupFuncs 2.5 Notes
  2. ---------- --- -----
  3.  
  4. December 1, 1994
  5.  
  6. Because PopupFuncs is so simple to use, this text file constitutes the
  7. documentation for installing and using PopupFuncs. It also contains
  8. up-to-date news and information.
  9.  
  10. The license agreement for PopupFuncs is at the end of this file. Please
  11. read it before installing and using the software.
  12.  
  13. Installation
  14. ------------
  15.  
  16. To install PopupFuncs, launch the “PopupFuncs Installer” application.
  17. For each editor you wish to use PopupFuncs in, click the “Choose” button
  18. to select the editor, and then click the “Install” button to install
  19. PopupFuncs in that editor. (The editor must not be running at the time.)
  20. If PopupFuncs has previously been installed in the chosen editor,
  21. the “Install” button will instead read “Update”.
  22.  
  23. If you are using System 7.5, or have Macintosh Drag and Drop installed,
  24. you can set up an application for installation by simply dragging it to
  25. the PopupFuncs installer’s main window.
  26.     
  27. After you have installed PopupFuncs in your editor(s), click the “Quit”
  28. button.
  29.  
  30. Standard File Hacks
  31. -------- ---- -----
  32.  
  33. There are some third-party extensions which modify the standard “Open” and
  34. “Save” dialogs (known colloquially as “Standard File”). In a couple of
  35. known cases, some of these extensions have a bug which causes correctly
  36. written applications to crash. Specifically:
  37.  
  38. -    “Click, there it is!”, version 1.0.1. Version 1.0.4 is current, and
  39.     fixes this problem. Registered owners should contact the author for
  40.     more information.
  41.     
  42. -    Quickeys version 2.1 also appears to have a similar problem.
  43.  
  44. If either of these extensions is installed, the PopupFuncs installer will
  45. crash when you click the “Choose...” button.
  46.  
  47. Supported Editors
  48. --------- -------
  49.  
  50. The following text editors (including integrated development environments)
  51. work with PopupFuncs. If you are writing an editor and would like to work
  52. with PopupFuncs, please write to us for information on the PopupFuncs API.
  53.  
  54. PopupFuncs 2.4 works with the following editors:
  55.  
  56.     BBEdit 2.5 and later (Bare Bones Software)
  57.     BBEdit Lite 2.3 and later (Bare Bones Software)
  58.     THINK C 5.0 and later (Symantec)
  59.     Symantec C++ 6.0 and later (Symantec)
  60.     CodeWarrior 1.0.1 and later (Metrowerks)
  61.     MPW Shell 3.0 through 3.3.2 (Apple Computer)
  62.     QUED/M 2.7 and later (Nisus Software)
  63.     
  64. At this time, PopupFuncs is incompatible with the prerelease versions of
  65. the “native” MPW Shell. We are working with Apple Computer to resolve the
  66. incompatibility, and will include the necessary changes in future releases
  67. of PopupFuncs.
  68.  
  69. Using PopupFuncs
  70. ----- ----------
  71.  
  72. PopupFuncs will place a pair of red dots in the title bar of any window that
  73. it believes contains a source file. To pop up a menu of functions in your
  74. source file, click either of the red dots. To sort the menu items by name,
  75. hold down the Shift key when clicking. To show the available PopupFuncs
  76. extensions, hold down the Command key when clicking.
  77.  
  78. In Rez source files, PopupFuncs will list defined resources. In C and C++
  79. source files, PopupFuncs will show types in addition to functions.
  80.  
  81. Customizing PopupFuncs
  82. ----------- ----------
  83.  
  84. PopupFuncs includes a number of special-purpose resources, which can be
  85. edited to customize the behavior of PopupFuncs. These resources, along 
  86. with a ‘TMPL’ resource, are included in the PopupFuncs installer. If
  87. you change these resources in the PopupFuncs installer, the changes
  88. will be carried along with subsequent installations of PopupFuncs.
  89.  
  90. The resources have a type of ‘puf!’, and the standard ones are as follows:
  91.  
  92. ‘puf!’ 128 is a list of language-to-suffix mappings. The language code
  93. is zero-based, and progresses as follows:
  94.  
  95.     none = 0;
  96.     C = 1;
  97.     C++ = 2;
  98.     Pascal = 3;
  99.     Object Pascal = 4;
  100.     Rez = 5;
  101.     68K assembler = 6;
  102.     Fortran = 7;
  103.     
  104. You can edit the suffix mappings to add your own custom suffixes.
  105.  
  106. ‘puf!’ 129 is used to configure the 68K assembly-language parser. Each
  107. entry in this resource is a pair of label/operand pairs:
  108.  
  109.     0   - mark the label , major. (e.g. PROC,FUNC)
  110.     1   - mark the label, minor 
  111.     2   - mark the parameter, major. Useful for macros whose first parameter 
  112.             is the real function name.
  113.     3    - mark the label, local, with a † next to it (e.g. RECORD)
  114.  
  115. PopupFuncs Demo
  116. ---------- ----
  117.  
  118. We have included a copy of the PopupFuncs demo package with each shipping
  119. copy of PopupFuncs. This is so that you can give a copy of PopupFuncs to
  120. anyone interested in trying it out, without actually giving away your own
  121. copy. The demo package also includes pricing and ordering information.
  122.  
  123. Problems?
  124. ---------
  125.  
  126. If you find that PopUpFuncs has difficulty with a particular source file,
  127. please send us a copy of your file. If the source file contains sensitive
  128. content, use the “Source Masher” utility to generate a copy of the source
  129. file without the sensitive information.
  130.  
  131. Thanks!
  132. -------
  133.  
  134. Thank you for purchasing PopupFuncs; we appreciate your business. If you
  135. have questions or problems, we encourage you to write, call, or send
  136. e-mail. (E-mail is the recommended way to contact us; we can reply very
  137. quickly, and it conserves paper.)
  138.  
  139. Bare Bones Software, Inc.
  140. P.O. Box 108
  141. Bedford, MA 01730
  142. (508) 651-3561 phone
  143. (508) 651-7584 fax
  144. bbsw@netcom.com [internet]
  145. 73051,3255 [CIS]
  146. BARE.BONES [AppleLink]
  147. BareBones [eWorld]
  148.  
  149. License Agreement                                                        
  150. ------- ---------
  151.  
  152. You, the Licensee, assume responsibility for the selection of the
  153. program PopupFuncs to achieve your intended results, and for the
  154. installation, use, and results obtained from the program.  installing
  155. and using the program constitutes your acceptance of these terms and
  156. conditions.  If you do not accept these terms and conditions, then do
  157. not install the software, and return the package for a full refund.
  158.  
  159. License
  160. -------
  161.  
  162. You may use the program on a single machine and copy the program into
  163. any machine-readable or printed form for backup or support of your use
  164. of the program on the single machine, provided that no more than one
  165. copy of the program may be used on a single machine by more than one
  166. user at a time.
  167.  
  168. You may not use, copy, modify, or transfer the program, or any copy 
  169. thereof, in whole or in part, except as provided in this Agreement.  If
  170. you use, copy, modify, or transfer the program, or any copy thereof, in
  171. whole or part, except as expressly provided for in this agreement, your
  172. license is automatically terminated.
  173.  
  174. The license is effective on the date you accept this Agreement, and
  175. remains in effect until terminated as indicated above or until you
  176. terminate it.  If the license is terminated for any reason, you agree to
  177. destroy the program, together with all copies thereof, in whole or in
  178. part, in any form, and to cease all use of the program.
  179.  
  180. Limited warranty and limitation of remedies
  181. ------- -------- --- ---------- -- --------
  182.  
  183. The program and any support from Bare Bones Software, Inc., are provided
  184. “as is” and without warranty , express and implied, including but not
  185. limited to any implied warranties of merchantability and fitness for a
  186. particular purpose.  In no event will Bare Bones Software, Inc. be
  187. liable for any damages, including lost profits, lost savings, or other
  188. incidental or consequential damages, even if Bare Bones Software, Inc.
  189. is advised of the possibility of such damages, or for any claim by you
  190. or any third party.  
  191.  
  192. General Terms
  193. ------- -----
  194.  
  195. This Agreement can only be modified by a written agreement signed by you
  196. and Bare Bones Software, Inc., and changes from the terms and conditions
  197. of this Agreement made in any other manner will be of no effect.  If any
  198. portion of this Agreement shall be held invalid, illegal, or
  199. unenforceable, the validity, legality, and enforceability of the
  200. remainder of the Agreement shall not in any way be affected or impaired
  201. thereby.  This Agreement shall be governed by the laws of The
  202. Commonwealth of Massachusetts, without giving effect to conflict of laws
  203. provisions thereof.  As required by United States export regulations,
  204. you shall not permit export of the program or any direct products
  205. thereof to any country to which export is then controlled by the United
  206. States Office of Export Administration, unless you have that agency’s
  207. prior written approval.  
  208.  
  209. Use, duplication and disclosure by the United States Government of the
  210. program or any part thereof is subject to restrictions as set forth in
  211. subdivision (g)(3) of Rights in Data - General Clause in Federal
  212. Acquisition Regulations (“FAR”) 52.227.14, the Commercial Computer
  213. Software - Restricted Rights Clause in FAR 52.227.19. and/or subdivision
  214. c(1)(ii) of Rights in Technical Data and Computer Software Clause in
  215. Department of Defense FAR 252.227.7013.
  216.  
  217. Acknowledgment
  218. --------------
  219.  
  220. You acknowledge that you have read this agreement, understand it, and
  221. agree to be bound by its terms and conditions.  You further agree that
  222. it is the complete and exclusive statement of the agreement between you
  223. and Bare Bones Software, Inc. which supersedes all proposals or prior
  224. agreements, oral or written, and all other communications between you
  225. and Bare Bones Software, Inc. relating to the subject matter of this
  226. agreement.
  227.